Filter hook 'add_{$meta_type}_metadata'
in WP Core File wp-includes/meta.php at line 80
Description
Short-circuits adding metadata of a specific type. The dynamic portion of the hook name, `$meta_type`, refers to the meta object type (post, comment, term, user, or any other type with an associated meta table). Returning a non-null value will effectively short-circuit the function. Possible hook names include: - `add_post_metadata` - `add_comment_metadata` - `add_term_metadata` - `add_user_metadata`
Occurrences
| Filename |
Line Number |
| wp-includes/meta.php |
80 |
Parameters
| Type |
Name |
Description |
| null|bool |
$check |
Whether to allow adding metadata for the given type. |
| int |
$object_id |
ID of the object metadata is for. |
| string |
$meta_key |
Metadata key. |
| mixed |
$meta_value |
Metadata value. Must be serializable if non-scalar. |
| bool |
$unique |
Whether the specified meta key should be unique for the object. |
PHP Doc
/**
* Short-circuits adding metadata of a specific type.
*
* The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
* (post, comment, term, user, or any other type with an associated meta table).
* Returning a non-null value will effectively short-circuit the function.
*
* Possible hook names include:
*
* - `add_post_metadata`
* - `add_comment_metadata`
* - `add_term_metadata`
* - `add_user_metadata`
*
* @since 3.1.0
*
* @param null|bool $check Whether to allow adding metadata for the given type.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Metadata key.
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
* @param bool $unique Whether the specified meta key should be unique for the object.
*/